API

Product APIs

GET product/units/{productUnitId}

Product unit details for the provided identifier

HTTP method GET
URI https://api.rambase.net/product/units/{productUnitId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productUnitId} Product unit identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 460, version 21

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ProductUnit>
2
     <ProductUnitId
ProductUnitId

Product unit identifier

>{Integer}</ProductUnitId>
3
     <Status
Status

Status of product unit

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <SerialNumber
SerialNumber

Serial number

>{String}</SerialNumber>
6
     <TreeLevel
TreeLevel

The treelevel (starting at 0) of the product unit

This field is greyed out because it is an expandable field. You have to add $expand=TreeLevel in your request URI to get this field

>{Integer}</TreeLevel>
7
     <BatchQuantity
BatchQuantity

Units quantity

>{Decimal}</BatchQuantity>
8
     <ContainsReplacedTraceableMaterial
ContainsReplacedTraceableMaterial

If true, part change on product unit has been performed

This field is greyed out because it is an expandable field. You have to add $expand=ContainsReplacedTraceableMaterial in your request URI to get this field

>{Boolean}</ContainsReplacedTraceableMaterial>
9
     <Marking
Marking

Product unit's marking text

>{String}</Marking>
10
     <ShippingAdviceItem
ShippingAdviceItem

The shipping advice item used for shipping. Note that this field is only available if no parents exists (tree level = 0).

>
11
          <Database
Database

Database of the object

>{String}</Database>
12
          <ShippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

>{Integer}</ShippingAdviceItemId>
13
          <ShippingAdvice>
14
               <ShippingAdviceId
ShippingAdviceId

Shipping advice identifier

>{Integer}</ShippingAdviceId>
15
               <ShippingDate
ShippingDate

The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)

>{Date}</ShippingDate>
16
               <ShippingAdviceLink
ShippingAdviceLink

Shipping advice reference

>{String}</ShippingAdviceLink>
17
          </ShippingAdvice>
18
          <ShippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

>{String}</ShippingAdviceItemLink>
19
     </ShippingAdviceItem>
20
     <ProductionWorkOrder>
21
          <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
22
          <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
23
     </ProductionWorkOrder>
24
     <Product>
25
          <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
26
          <Name
Name

Name of the product

>{String}</Name>
27
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
28
     </Product>
29
     <ParentProductUnits
ParentProductUnits

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

>
30
          <ProductUnit
ProductUnit

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

>
31
               <ProductUnitId
ProductUnitId

Product unit identifier

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

>{Integer}</ProductUnitId>
32
               <Status
Status

Status of product unit

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

>{Integer}</Status>
33
               <TreeLevel
TreeLevel

The treelevel (starting at 0) of the product unit

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

>{Integer}</TreeLevel>
34
               <ProductUnitLink
ProductUnitLink

Product unit reference

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

>{String}</ProductUnitLink>
35
          </ProductUnit>
36
     </ParentProductUnits>
37
</ProductUnit>
1
{
2
     "productUnit": {
3
          "productUnitId
ProductUnitId

Product unit identifier

": "{Integer}",
4
          "status
Status

Status of product unit

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "serialNumber
SerialNumber

Serial number

": "{String}",
7
          "treeLevel
TreeLevel

The treelevel (starting at 0) of the product unit

This field is greyed out because it is an expandable field. You have to add $expand=TreeLevel in your request URI to get this field

": "{Integer}",
8
          "batchQuantity
BatchQuantity

Units quantity

": "{Decimal}",
9
          "containsReplacedTraceableMaterial
ContainsReplacedTraceableMaterial

If true, part change on product unit has been performed

This field is greyed out because it is an expandable field. You have to add $expand=ContainsReplacedTraceableMaterial in your request URI to get this field

": "{Boolean}",
10
          "marking
Marking

Product unit's marking text

": "{String}",
11
          "shippingAdviceItem
ShippingAdviceItem

The shipping advice item used for shipping. Note that this field is only available if no parents exists (tree level = 0).

": {
12
               "database
Database

Database of the object

": "{String}",
13
               "shippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

": "{Integer}",
14
               "shippingAdvice": {
15
                    "shippingAdviceId
ShippingAdviceId

Shipping advice identifier

": "{Integer}",
16
                    "shippingDate
ShippingDate

The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)

": "{Date}",
17
                    "shippingAdviceLink
ShippingAdviceLink

Shipping advice reference

": "{String}"
18
               },
19
               "shippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

": "{String}"
20
          },
21
          "productionWorkOrder": {
22
               "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
23
               "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
24
          },
25
          "product": {
26
               "productId
ProductId

Product identifier

": "{Integer}",
27
               "name
Name

Name of the product

": "{String}",
28
               "productLink
ProductLink

Product reference

": "{String}"
29
          },
30
          "parentProductUnits
ParentProductUnits

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

": [
31
               {
32
                    "productUnitId
ProductUnitId

Product unit identifier

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

": "{Integer}",
33
                    "status
Status

Status of product unit

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

": "{Integer}",
34
                    "treeLevel
TreeLevel

The treelevel (starting at 0) of the product unit

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

": "{Integer}",
35
                    "productUnitLink
ProductUnitLink

Product unit reference

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductUnits in your request URI to get this field

": "{String}"
36
               }
37
          ]
38
     }
39
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100133 HTTP 400 Product unit not found